Get verification by Identity

Queries the verification result using the verification identity (typically a phone number) along with the verification method.

This API can be used to retrieve the verification status associated with a specific user identity.

• UAT BASE-URL- https://smv.sinchconverse.com/verification
  
• Production BASE-URL- https://smvprod.sinchconverse.com/verification

Request Type: GET

Sample Request:

curl -X GET '{BASE-URL}/v1/verifications/{method}/number/{endpoint}'

Parameter	Description	JSON Type	Required
method	The method of the verification.	string	Yes
endpoint	E.164 phone number (example: +46700000000).	string	Yes

Sample Response:

{
    "identity": {
        "type": "number",
        "endpoint": "+91XXXXXXXXXX"
    },
    "method": "seamless",
    "reference": "",
    "id": "XXXXXXXXXXXXXXXXXXXX",
    "status": "PENDING",
    "reason": "Expired",
    "countryId": null,
    "verificationTimestamp": "XXXX-XX-XXXXX:15:43Z",
    "price": {
        "currencyId": "INR",
        "amount": "0.X"
    },
    "source": null
}

A success response, or an Error.

Parameter	Description	JSON Type	Required
id	Unique identifier of the verification request. This value matches the ID returned when the verification was started.	String	Yes
status	Current status of the verification process. Indicates whether the verification is pending, successful, or failed.	string	Yes
reason	Provides additional information explaining why the verification failed or was denied.	string	No
reference	Custom reference value provided when initiating the verification request. Useful for mapping the verification to internal systems.	string	No
identity	Contains the details of the identity that was verified (usually the user's phone number).	object	yes
type	Type of identity being verified. Currently the value is "number".	String	yes
endpoint	The phone number that is being verified in E.164 format.	string	Yes
countryId	The ID of the country to which the verification was sent.	string	No
verificationTimestamp	The timestamp in UTC format. Example:"2023-04-21T14:45:51"	object	yes
method	The verification method used for the request (e.g., sms, flashcall, callout, seamless).	string	yes
price	Prices associated with this verification.This property will appear in the body of the response with a delay. It will become visible only when the verification status is other than PENDING.	object	yes
currencyId		string	yes
amount		string	yes
source	Indicates how the verification was completed (automatic interception or manual entry). Mostly relevant for SMS OTP flows.	string	No

Enum values of status:

Status	Description
PENDING	Verification is still ongoing.
SUCCESSFUL	The phone number was successfully verified.
FAIL	Verification attempt was made but failed.
DENIED	Verification was denied by Sinch or your backend.
ABORTED	Verification was cancelled because another verification was initiated.
ERROR	Verification could not be completed due to network error or unreachable number.

Enum values of reason:

Enum Value	Description
Denied by callback	Callback response denied the verification.
Invalid callback	Callback was invalid.
Internal error	Internal server error.
Destination denied	Verification destination denied.
Fraud	Fraudulent activity.
Not enough credit	Not enough credit in dashboard account.
Blocked	Blocked number.
Network error or number unreachable	Network error or destination number is otherwise unreachable.
Failed pending	Pending failure.
SMS delivery failure	Could not deliver SMS.
Invalid CLI	CLI is invalid.
Invalid code	Input code is invalid.
Expired	Verification request has expired.
Hung up without entering valid code	Phone call ended without entering code.